<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>uartpsv: xuartpsv.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">uartpsv
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xuartpsv_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xuartpsv.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga8dc8acae0282012aa1a20d979be436a6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartpsv.html#ga8dc8acae0282012aa1a20d979be436a6">XUARTPSV_MAX_BAUD_ERROR_RATE</a>&#160;&#160;&#160;3U</td></tr>
<tr class="memdesc:ga8dc8acae0282012aa1a20d979be436a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">max % error allowed  <a href="group__uartpsv.html#ga8dc8acae0282012aa1a20d979be436a6">More...</a><br/></td></tr>
<tr class="separator:ga8dc8acae0282012aa1a20d979be436a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gae977262c7eae574f573fe4122ac6c0ab"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartpsv.html#gae977262c7eae574f573fe4122ac6c0ab">XUartPsv_CfgInitialize</a> (<a class="el" href="struct_x_uart_psv.html">XUartPsv</a> *InstancePtr, <a class="el" href="struct_x_uart_psv___config.html">XUartPsv_Config</a> *Config, UINTPTR EffectiveAddr)</td></tr>
<tr class="memdesc:gae977262c7eae574f573fe4122ac6c0ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes a specific <a class="el" href="struct_x_uart_psv.html" title="The XUartPsv driver instance data structure. ">XUartPsv</a> instance such that it is ready to be used.  <a href="group__uartpsv.html#gae977262c7eae574f573fe4122ac6c0ab">More...</a><br/></td></tr>
<tr class="separator:gae977262c7eae574f573fe4122ac6c0ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga71a962de4963e15f1c38e7831e825f7c"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartpsv.html#ga71a962de4963e15f1c38e7831e825f7c">XUartPsv_Send</a> (<a class="el" href="struct_x_uart_psv.html">XUartPsv</a> *InstancePtr, u8 *BufferPtr, u32 NumBytes)</td></tr>
<tr class="memdesc:ga71a962de4963e15f1c38e7831e825f7c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This functions sends the specified buffer using the device in either polled or interrupt driven mode.  <a href="group__uartpsv.html#ga71a962de4963e15f1c38e7831e825f7c">More...</a><br/></td></tr>
<tr class="separator:ga71a962de4963e15f1c38e7831e825f7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac551c919a38424e6d23298256a9d1141"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartpsv.html#gac551c919a38424e6d23298256a9d1141">XUartPsv_Send_NoWait</a> (<a class="el" href="struct_x_uart_psv.html">XUartPsv</a> *InstancePtr, u8 *BufferPtr, u32 NumBytes)</td></tr>
<tr class="memdesc:gac551c919a38424e6d23298256a9d1141"><td class="mdescLeft">&#160;</td><td class="mdescRight"><ul>
<li></li>
</ul>
 <a href="group__uartpsv.html#gac551c919a38424e6d23298256a9d1141">More...</a><br/></td></tr>
<tr class="separator:gac551c919a38424e6d23298256a9d1141"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4d4d20bbcedb1de2adbe2644b821d12d"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartpsv.html#ga4d4d20bbcedb1de2adbe2644b821d12d">XUartPsv_Recv</a> (<a class="el" href="struct_x_uart_psv.html">XUartPsv</a> *InstancePtr, u8 *BufferPtr, u32 NumBytes)</td></tr>
<tr class="memdesc:ga4d4d20bbcedb1de2adbe2644b821d12d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function attempts to receive a specified number of bytes of data from the device and store it into the specified buffer.  <a href="group__uartpsv.html#ga4d4d20bbcedb1de2adbe2644b821d12d">More...</a><br/></td></tr>
<tr class="separator:ga4d4d20bbcedb1de2adbe2644b821d12d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2236ec3fe4acd721566be3025554826b"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartpsv.html#ga2236ec3fe4acd721566be3025554826b">XUartPsv_SendBuffer</a> (<a class="el" href="struct_x_uart_psv.html">XUartPsv</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga2236ec3fe4acd721566be3025554826b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends a buffer that has been previously specified by setting up the instance variables of the instance.  <a href="group__uartpsv.html#ga2236ec3fe4acd721566be3025554826b">More...</a><br/></td></tr>
<tr class="separator:ga2236ec3fe4acd721566be3025554826b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab7c628a4fd29e1f9d1d4cb9cbe672279"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartpsv.html#gab7c628a4fd29e1f9d1d4cb9cbe672279">XUartPsv_ReceiveBuffer</a> (<a class="el" href="struct_x_uart_psv.html">XUartPsv</a> *InstancePtr)</td></tr>
<tr class="memdesc:gab7c628a4fd29e1f9d1d4cb9cbe672279"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function receives a buffer that has been previously specified by setting up the instance variables of the instance.  <a href="group__uartpsv.html#gab7c628a4fd29e1f9d1d4cb9cbe672279">More...</a><br/></td></tr>
<tr class="separator:gab7c628a4fd29e1f9d1d4cb9cbe672279"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8c73264d5304f3187edb896bab76dcb0"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartpsv.html#ga8c73264d5304f3187edb896bab76dcb0">XUartPsv_SetBaudRate</a> (<a class="el" href="struct_x_uart_psv.html">XUartPsv</a> *InstancePtr, u32 BaudRate)</td></tr>
<tr class="memdesc:ga8c73264d5304f3187edb896bab76dcb0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the baud rate for the device.  <a href="group__uartpsv.html#ga8c73264d5304f3187edb896bab76dcb0">More...</a><br/></td></tr>
<tr class="separator:ga8c73264d5304f3187edb896bab76dcb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa19ed118438249d9c56cd3afcfa8898c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartpsv.html#gaa19ed118438249d9c56cd3afcfa8898c">XUartPsv_ProgramCtrlReg</a> (<a class="el" href="struct_x_uart_psv.html">XUartPsv</a> *InstancePtr, u32 CtrlRegister)</td></tr>
<tr class="memdesc:gaa19ed118438249d9c56cd3afcfa8898c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reprograms the control register according to the following sequence mentioned in the TRM.  <a href="group__uartpsv.html#gaa19ed118438249d9c56cd3afcfa8898c">More...</a><br/></td></tr>
<tr class="separator:gaa19ed118438249d9c56cd3afcfa8898c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga048adc3a5ea0979d28266476fa3960db"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartpsv.html#ga048adc3a5ea0979d28266476fa3960db">XUartPsv_CleanupRx</a> (<a class="el" href="struct_x_uart_psv.html">XUartPsv</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga048adc3a5ea0979d28266476fa3960db"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is a cleanup function to allow reseting Rx NextBytePtr, RemainingBytes and RequestedBytes.  <a href="group__uartpsv.html#ga048adc3a5ea0979d28266476fa3960db">More...</a><br/></td></tr>
<tr class="separator:ga048adc3a5ea0979d28266476fa3960db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf1cde67fba29b14f65e5abe2dd7d2066"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartpsv.html#gaf1cde67fba29b14f65e5abe2dd7d2066">XUartPsv_CleanupTx</a> (<a class="el" href="struct_x_uart_psv.html">XUartPsv</a> *InstancePtr)</td></tr>
<tr class="memdesc:gaf1cde67fba29b14f65e5abe2dd7d2066"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is a cleanup function to allow reseting Tx NextBytePtr, RemainingBytes and RequestedBytes.  <a href="group__uartpsv.html#gaf1cde67fba29b14f65e5abe2dd7d2066">More...</a><br/></td></tr>
<tr class="separator:gaf1cde67fba29b14f65e5abe2dd7d2066"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
